Skip to content

Use ">>" in place of "-" between package index ID components #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2021
Merged

Use ">>" in place of "-" between package index ID components #210

merged 1 commit into from
Jul 21, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 21, 2021

Since package index data occurs in arrays, the rules must indicate to the user the specific element(s) in violation. In the case of standard components (e.g. platform), the form of the IDs is well established (e.g., arduino:[email protected]). However, that I know of, there is no standard form for unequivocally identifying a package index data subcomponent (e.g., a tool dependency of a specific platform release).

I arbitrarily chose a dash to combine the IDs of the two components (e.g., arduino:[email protected] - x86_64-linux-gnu). I received feedback that this was not very clear, with a suggestion to use ">>" instead of the "-" (e.g., arduino:[email protected] >> x86_64-linux-gnu).

Since package index data occurs in arrays, the rules must indicate to the user the specific element(s) in violation. In
the case of standard components (e.g. platform), the form of the IDs is well established (e.g., `arduino:[email protected]`).
However, that I know of, there is no standard form for unequivocally identifying a package index data subcomponent (e.g.,
a tool dependency of a specific platform release).

I arbitrarily chose a dash to combine the IDs of the two components (e.g.,
`arduino:[email protected] - x86_64-linux-gnu`). I received feedback that this was not very clear, with a
suggestion to use ">>" instead of the "-" (e.g., `arduino:[email protected] >> x86_64-linux-gnu`).
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Jul 21, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #210 (a63d3a8) into main (24d0055) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #210      +/-   ##
==========================================
+ Coverage   87.93%   87.96%   +0.02%     
==========================================
  Files          43       43              
  Lines        4160     4170      +10     
==========================================
+ Hits         3658     3668      +10     
  Misses        391      391              
  Partials      111      111              
Flag Coverage Δ
unit 87.96% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
internal/project/projectdata/packageindex.go 100.00% <100.00%> (ø)
internal/result/result.go 90.22% <0.00%> (+0.79%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 24d0055...a63d3a8. Read the comment docs.

@per1234 per1234 merged commit 3fb6daf into arduino:main Jul 21, 2021
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants